<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
        <head><title>trait Reporter in org.scalatest</title>
        <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.2.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script>
        </head>
        <body onload="init()">
        <table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">ScalaTest 0.9.4</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
        
      <div class="entity">
        <a href="../../org/scalatest$package.html" target="_self">org.scalatest</a>
        <br></br>
        <span class="entity">trait  Reporter</span>
      </div><hr></hr>
      <div class="source">
        [source: <a href="" class="org/scalatest/Reporter"><code>org/scalatest/Reporter.scala</code></a>]
      </div><hr></hr>
      <a name="Reporter"></a><dl>
      <dt>
        
        <code></code>
        <code>trait</code>
        <em>Reporter</em>
      </dt>
      <dd><code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a></dd>
    </dl>
      <dl><dd>Trait whose instances collect the results of a running
 suite of tests and presents those results in some way to the user.

 <p>
 <code>Reporter</code>s receive test results via twelve
 <em>report methods</em>. Each report method is invoked to pass a particular kind of report to
 the reporter. The report methods are:
 </p>

 <ul>
 <li><code>runStarting</code>
 <li><code>testStarting</code>
 <li><code>testSucceeded</code>
 <li><code>testFailed</code>
 <li><code>testIgnored</code>
 <li><code>suiteStarting</code>
 <li><code>suiteCompleted</code>
 <li><code>suiteAborted</code>
 <li><code>infoProvided</code>
 <li><code>runStopped</code>
 <li><code>runAborted</code>
 <li><code>runCompleted</code>
 </ul>

 <p>
 <code>Reporter</code>s may be implemented such that they only present some of the reports to the user. For example, you could
 define a reporter class whose <code>suiteStarting</code> method
 does nothing. Such a class would always ignore <code>suiteStarting</code> reports.
 </p>

 <p>
 The term <em>test</em> as used in the <code>testStarting</code>, <code>testSucceeded</code>,
 and <code>testFailed</code> method names
 is defined abstractly to enable a wide range of test implementations.
 Trait <code>Suite</code> invokes <code>testStarting</code> to indicate it is about to invoke one
 of its test methods, <code>testSucceeded</code> to indicate a test method returned normally,
 and <code>testFailed</code> to indicate a test method completed abruptly with an exception.
 Although the execution of a <code>Suite</code>'s test methods will likely be a common event
 reported via the
 <code>testStarting</code>, <code>testSucceeded</code>, and <code>testFailed</code> methods, because
 of the abstract definition of &#8220;test&#8221; used by this
 interface, these methods are not limited to this use. Information about any conceptual test
 may be reported via the <code>testStarting</code>, <code>testSucceeded</code>, and
 <code>testFailed</code> methods.

 <p>
 Likewise, the term <em>suite</em> as used in the <code>suiteStarting</code>, <code>suiteAborted</code>,
 and <code>suiteCompleted</code> method names
 is defined abstractly to enable a wide range of suite implementations.
 Object <code>Runner</code> invokes <code>suiteStarting</code> to indicate it is about to invoke
 <code>execute</code> on a
 <code>Suite</code>, <code>suiteCompleted</code> to indicate a <code>Suite</code>'s
 <code>execute</code> method returned normally,
 and <code>suiteAborted</code> to indicate a <code>Suite</code>'s <code>execute</code>
 method completed abruptly with an exception.
 Similarly, class <code>Suite</code> invokes <code>suiteStarting</code> to indicate it is about to invoke
 <code>execute</code> on a
 nested <code>Suite</code>, <code>suiteCompleted</code> to indicate a nested <code>Suite</code>'s
 <code>execute</code> method returned normally,
 and <code>suiteAborted</code> to indicate a nested <code>Suite</code>'s <code>execute</code>
 method completed abruptly with an exception.
 Although the execution of a <code>Suite</code>'s <code>execute</code> method will likely be a
 common event reported via the
 <code>suiteStarting</code>, <code>suiteAborted</code>, and <code>suiteCompleted</code> methods, because
 of the abstract definition of "suite" used by this
 interface, these methods are not limited to this use. Information about any conceptual suite
 may be reported via the <code>suiteStarting</code>, <code>suiteAborted</code>, and
 <code>suiteCompleted</code> methods.

 <p>
 <strong>Extensibility</strong>
 </p>

 <p>
 You can create classes that extend <code>Reporter</code> to report test results in custom ways, and to
 report custom information passed to <code>Report</code> subclass instances. For more information on the latter
 use case, see the <em>Extensibility</em> section of the <a href="Report.html"><code>Report</code> documentation</a>.
 </p>

 <p>
 <code>Reporter</code> classes can handle invocations of its report methods in any manner, including doing nothing.
 For convenience, trait <code>Reporter</code> includes a default implentation of each report method that does nothing.
 </p></dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Author</b></dt><dd>Bill Venners</dd></dl>
    
      


<table summary="" cellpadding="3" class="member">
      <tr><td class="title" colspan="2">Method Summary</td></tr>
      <tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#dispose%28%29" target="_self">dispose</a></em>
         : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Release any non-memory finite resources, such as file handles, held by this <code>Reporter</code>. Clients should
     call this method when they no longer need the <code>Reporter</code>, before releasing the last reference
     to the <code>Reporter</code>. After this method is invoked, the <code>Reporter</code> may be defunct,
     and therefore not usable anymore. If the <code>Reporter</code> holds no resources, it may do nothing when
     this method is invoked.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#infoProvided%28org.scalatest.Report%29" target="_self">infoProvided</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Provides information that is not appropriate to report via any other
     <code>Reporter</code> method.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#runAborted%28org.scalatest.Report%29" target="_self">runAborted</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a runner encountered an error while attempting to run a suite of tests.
    
     <P>
     Object <code>Runner</code> invokes <code>runAborted</code> if the
     <code>execute</code> method of any of the run's starting <code>Suite</code>s completes
     abruptly with a <code>Throwable</code>.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#runCompleted%28%29" target="_self">runCompleted</a></em>
         : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a runner has completed running a suite of tests.
    
     <P> FIX
     Class <code>Suite</code> has a static method <code>setStopRequested</code>, which takes
     a <code>boolean</code> parameter. If <code>false</code> is passed to
     <code>setStopRequested</code> while a <code>Suite</code> of tests is running, the
     <code>execute</code> method of all <code>Suite</code>'s should promptly
     return even if they haven't finished running all of their tests.
    
     <P>
     Object <code>Runner</code> invokes <code>runFinished</code>
     when the last <code>execute</code> method of the run's starting <code>Suite</code>s returns,
     unless a stop is requested. If a stop is requested
     via <code>Suite</code>'s static <code>setStopRequested</code> method, class <code>Runner</code>
     invokes <code>runStopped</code> when the last <code>execute</code> method of the run's
     starting <code>Suite</code>s returns.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#runStarting%28Int%29" target="_self">runStarting</a></em>
        (<em>testCount</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a runner is about run a suite of tests.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#runStopped%28%29" target="_self">runStopped</a></em>
         : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a runner has stopped running a suite of tests prior to completion, likely
     because of a stop request.
    
     <P> FIX ME
     <code>Suite</code>'s <code>execute</code> method takes a <code>Stopper</code>, whose <code>stopRequested</code>
     method indicates a stop was requested. Code responsible for running tests and suites, such as the 
     a <code>boolean</code> parameter. If <code>false</code> is passed to
     <code>setStopRequested</code> while a <code>Suite</code> of tests is running, the
     <code>execute</code> method of all <code>Suite</code>'s should promptly
     return even if they haven't finished running all of their tests.
    
     <P>If a stop is requested via <code>Suite</code>'s static <code>setStopRequested</code>
     method, class <code>Runner</code> invokes <code>runStopped</code>
     when the <code>execute</code> method of the run's starting <code>Suite</code> returns.
     If a stop is not requested, class <code>Runner</code> invokes <code>runCompleted</code>
     when the last <code>execute</code> method of the run's starting <code>Suite</code>s returns.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#suiteAborted%28org.scalatest.Report%29" target="_self">suiteAborted</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates the execution of a suite of tests has aborted, likely because of an error, prior
     to completion.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#suiteCompleted%28org.scalatest.Report%29" target="_self">suiteCompleted</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite of tests has completed executing.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#suiteStarting%28org.scalatest.Report%29" target="_self">suiteStarting</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite of tests is about to start executing.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#testFailed%28org.scalatest.Report%29" target="_self">testFailed</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite (or other entity) has completed running a test that failed.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#testIgnored%28org.scalatest.Report%29" target="_self">testIgnored</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite (or other entity) is annotated as a ignore test.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#testStarting%28org.scalatest.Report%29" target="_self">testStarting</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite (or other entity) is about to start a test.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../org/scalatest/Reporter.html#testSucceeded%28org.scalatest.Report%29" target="_self">testSucceeded</a></em>
        (<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        <div>Indicates a suite (or other entity) has completed running a test that succeeded.</div>
      </td>
    </tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a>
        </td></tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a>
        </td></tr>
      </table>


      


<table summary="" cellpadding="3" class="member-detail">
          <tr><td class="title">Method Details</td></tr>
        </table><div><a name="runStarting%28Int%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>runStarting</em>(<em>testCount</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a runner is about run a suite of tests.
    
     <p>
     Object <code>Runner</code> invokes <code>runStarting</code> to report
     that the first <code>execute</code> method of a run's starting <code>Suite</code>s
     is about to be invoked.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>testCount - </code>the number of tests expected during this run</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>IllegalArgumentException - </code>if <code>expectedTestsCount</code> is less than zero.</dd></dl>
    <hr></hr>
<a name="testStarting%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>testStarting</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite (or other entity) is about to start a test.
    
     <p>
     Trait <code>Suite</code> uses <code>testStarting</code> to report
     that a test method of a <code>Suite</code> is about to be invoked.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the test starting event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="testSucceeded%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>testSucceeded</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite (or other entity) has completed running a test that succeeded.
    
     <p>
     Trait <code>Suite</code> uses <code>testSucceeded</code> to report
     that a test method of a <code>Suite</code> returned normally
     (without throwing an <code>Exception</code>).</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the test succeeded event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="testIgnored%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>testIgnored</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite (or other entity) is annotated as a ignore test.
     
     <p>
     Trait <code>Suite</code> uses <code>testIgnored</code> to report 
     that a test method of a <code>Suite</code> is annotated as @Ignore.
     Ignored test will not be run, but will be reported as reminder to fix the broken test.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the ignored test event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="testFailed%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>testFailed</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite (or other entity) has completed running a test that failed.
    
     <p>
     Trait <code>Suite</code> uses <code>testFailed</code> to report
     that a test method of a <code>Suite</code>
     completed abruptly with an <code>Exception</code>.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the test failed event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="suiteStarting%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>suiteStarting</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite of tests is about to start executing.
    
     <p>
     Trait <code>Suite</code> and Object <code>Runner</code> use <code>suiteStarting</code> to report
     that the <code>execute</code> method of a <code>Suite</code>
     is about to be invoked.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the suite starting event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="suiteCompleted%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>suiteCompleted</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a suite of tests has completed executing.
    
     <p>
     Trait <code>Suite</code> and Object <code>Runner</code> use <code>suiteCompleted</code> to report
     that the <code>execute</code> method of a <code>Suite</code>
     has returned normally (without throwing a <code>RuntimeException</code>).</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the suite completed event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="suiteAborted%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>suiteAborted</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates the execution of a suite of tests has aborted, likely because of an error, prior
     to completion.
    
     <p>
     Trait <code>Suite</code> and Object <code>Runner</code> use <code>suiteAborted</code> to report
     that the <code>execute</code> method of a <code>Suite</code>
     has completed abruptly with a <code>RuntimeException</code>.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the suite aborted event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="infoProvided%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>infoProvided</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Provides information that is not appropriate to report via any other
     <code>Reporter</code> method.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="runStopped%28%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>runStopped</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a runner has stopped running a suite of tests prior to completion, likely
     because of a stop request.
    
     <P> FIX ME
     <code>Suite</code>'s <code>execute</code> method takes a <code>Stopper</code>, whose <code>stopRequested</code>
     method indicates a stop was requested. Code responsible for running tests and suites, such as the 
     a <code>boolean</code> parameter. If <code>false</code> is passed to
     <code>setStopRequested</code> while a <code>Suite</code> of tests is running, the
     <code>execute</code> method of all <code>Suite</code>'s should promptly
     return even if they haven't finished running all of their tests.
    
     <P>If a stop is requested via <code>Suite</code>'s static <code>setStopRequested</code>
     method, class <code>Runner</code> invokes <code>runStopped</code>
     when the <code>execute</code> method of the run's starting <code>Suite</code> returns.
     If a stop is not requested, class <code>Runner</code> invokes <code>runCompleted</code>
     when the last <code>execute</code> method of the run's starting <code>Suite</code>s returns.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="runAborted%28org.scalatest.Report%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>runAborted</em>(<em>report</em> : <a href="../../org/scalatest/Report.html" target="_self">Report</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a runner encountered an error while attempting to run a suite of tests.
    
     <P>
     Object <code>Runner</code> invokes <code>runAborted</code> if the
     <code>execute</code> method of any of the run's starting <code>Suite</code>s completes
     abruptly with a <code>Throwable</code>.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Parameters</b></dt><dd><code>report - </code>a <code>Report</code> that encapsulates the run aborted event to report.</dd><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>NullPointerException - </code>if <code>report</code> reference is <code>null</code></dd></dl>
    <hr></hr>
<a name="runCompleted%28%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>runCompleted</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates a runner has completed running a suite of tests.
    
     <P> FIX
     Class <code>Suite</code> has a static method <code>setStopRequested</code>, which takes
     a <code>boolean</code> parameter. If <code>false</code> is passed to
     <code>setStopRequested</code> while a <code>Suite</code> of tests is running, the
     <code>execute</code> method of all <code>Suite</code>'s should promptly
     return even if they haven't finished running all of their tests.
    
     <P>
     Object <code>Runner</code> invokes <code>runFinished</code>
     when the last <code>execute</code> method of the run's starting <code>Suite</code>s returns,
     unless a stop is requested. If a stop is requested
     via <code>Suite</code>'s static <code>setStopRequested</code> method, class <code>Runner</code>
     invokes <code>runStopped</code> when the last <code>execute</code> method of the run's
     starting <code>Suite</code>s returns.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="dispose%28%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>dispose</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Release any non-memory finite resources, such as file handles, held by this <code>Reporter</code>. Clients should
     call this method when they no longer need the <code>Reporter</code>, before releasing the last reference
     to the <code>Reporter</code>. After this method is invoked, the <code>Reporter</code> may be defunct,
     and therefore not usable anymore. If the <code>Reporter</code> holds no resources, it may do nothing when
     this method is invoked.</dd></dl>
      <dl></dl>
    <hr></hr></div>


    <hr></hr>
        <div>Copyright (C) 2001-2008 Artima, Inc. All rights reserved.</div><table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">ScalaTest 0.9.4</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
      </body>
      </html>